docs: mention id field in 1-abstract-dto.rst
#3803
Conversation
github-actions
bot
added
area/docs
|
|
I'm not really sure "special" is the right wording here, since it's simply an inherited attribute. It only happens to be the only one that's inherited from the base class, but there's nothing special about the |
|
@provinzkraut can we say that "id is readonly because it is a primary key"? |
I think it should say something like "we mark |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3803 +/- ##
=======================================
Coverage 98.36% 98.36%
=======================================
Files 346 347 +1
Lines 15690 15722 +32
Branches 1737 1737
=======================================
+ Hits 15433 15465 +32
Misses 122 122
Partials 135 135 ☔ View full report in Codecov by Sentry. |
|
I'm going to go ahead and merge with the provided updates. We can open a followup PR to dial in the verbiage if needed. Thanks @sobolevn |
|
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3803 |
It caught my attention that it was never explained: why do we have an extra
idfield in the response. Since this part is dedicated to explaining how request / response fields are marked, I think that it is important to mention thatidis special:I had to grep what
.my_libis and howclass _Base(CommonTableAttributes, UUIDPrimaryKey, DeclarativeBase):is constructed. Only findingUUIDPrimaryKeyand itsid: Mapped[UUID] = mapped_column(default=uuid4, primary_key=True)has anwsered my question :)